IRecordPlanCompiler<'model, 'result>Type

PackageReified.Schema
Builds an interpreter-specific typed record plan from a model schema's authored shape.

Specification

Kind
Type
Members
3
Examples
0
OnCompleteSignature
this.OnComplete
OnEndSignature
this.OnEnd
OnFieldSignature
this.OnField

Summary

NameSignatureSynopsis
OnCompletethis.OnCompleteCompletes a record plan with the original typed constructor.
OnEndthis.OnEndStarts a record plan for a constructor with no consumed fields.
OnFieldthis.OnFieldAppends one typed field to an interpreter-specific record plan.

OnComplete

this.OnComplete
Member
Completes a record plan with the original typed constructor.

Parameters

NameTypeDescription
constructor'constructor
planIRecordPlanState<'model, 'constructor, 'constructed>
finish'constructed -> Result<'model, string>

Returns

'result

OnEnd

this.OnEnd
Member
Starts a record plan for a constructor with no consumed fields.

Returns

IRecordPlanState<'model, 'constructor, 'constructor>

OnField

this.OnField
Member
Appends one typed field to an interpreter-specific record plan.

Parameters

NameTypeDescription
orderint
fieldField<'model, 'field>
headIRecordPlanState<'model, 'constructorIn, ('field -> 'next)>

Returns

IRecordPlanState<'model, 'constructorIn, 'next>